<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>sstruct</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://openttd-python.googlecode.com">OpenTTD-Python</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;sstruct
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="sstruct-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="sstruct-module.html">Module sstruct</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-docstring">"""sstruct.py -- SuperStruct</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-docstring">Higher level layer on top of the struct module, enabling to </tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-docstring">bind names to struct elements. The interface is similar to </tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-docstring">struct, except the objects passed and returned are not tuples </tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-docstring">(or argument lists), but dictionaries or instances. </tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-docstring">Just like struct, we use format strings to describe a data </tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-docstring">structure, except we use one line per element. Lines are </tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-docstring">separated by newlines or semi-colons. Each line contains </tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-docstring">either one of the special struct characters ('@', '=', '&lt;', </tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-docstring">'&gt;' or '!') or a 'name:formatchar' combo (eg. 'myFloat:f'). </tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-docstring">Repetitions, like the struct module offers them are not useful </tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-docstring">in this context, except for fixed length strings  (eg. 'myInt:5h' </tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-docstring">is not allowed but 'myString:5s' is). The 'x' format character </tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-docstring">(pad byte) is treated as 'special', since it is by definition </tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-docstring">anonymous. Extra whitespace is allowed everywhere.</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-docstring">The sstruct module offers one feature that the "normal" struct</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-docstring">module doesn't: support for fixed point numbers. These are spelled</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-docstring">as "n.mF", where n is the number of bits before the point, and m</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-docstring">the number of bits after the point. Fixed point numbers get </tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-docstring">converted to floats.</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring">pack(format, object):</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring">        'object' is either a dictionary or an instance (or actually</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring">        anything that has a __dict__ attribute). If it is a dictionary, </tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-docstring">        its keys are used for names. If it is an instance, it's </tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring">        attributes are used to grab struct elements from. Returns</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-docstring">        a string containing the data.</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">unpack(format, data, object=None)</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">        If 'object' is omitted (or None), a new dictionary will be </tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">        returned. If 'object' is a dictionary, it will be used to add </tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring">        struct elements to. If it is an instance (or in fact anything</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-docstring">        that has a __dict__ attribute), an attribute will be added for </tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-docstring">        each struct element. In the latter two cases, 'object' itself </tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-docstring">        is returned.</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring">unpack2(format, data, object=None)</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring">        Convenience function. Same as unpack, except data may be longer </tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring">        than needed. The returned value is a tuple: (object, leftoverdata).</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-docstring">calcsize(format)</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-docstring">        like struct.calcsize(), but uses our own format strings:</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-docstring">        it returns the size of the data in bytes.</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-comment"># XXX I would like to support pascal strings, too, but I'm not</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-comment"># sure if that's wise. Would be nice if struct supported them</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-comment"># "properly", but that would certainly break calcsize()...</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-name">__version__</tt> <tt class="py-op">=</tt> <tt class="py-string">"1.2"</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-name">__copyright__</tt> <tt class="py-op">=</tt> <tt class="py-string">"Copyright 1998, Just van Rossum &lt;just@letterror.com&gt;"</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">struct</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">types</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"> </tt>
<a name="error"></a><div id="error-def"><a name="L61"></a><tt class="py-lineno"> 61</tt> <a class="py-toggle" href="#" id="error-toggle" onclick="return toggle('error');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="sstruct.error-class.html">error</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="error-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="error-expanded"><a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line">    <tt id="link-0" class="py-name" targets="Variable sstruct.error.name=sstruct.error-class.html#name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-0', 'name', 'link-0');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-string">"sstruct.error"</tt> </tt>
</div><a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"> </tt>
<a name="pack"></a><div id="pack-def"><a name="L64"></a><tt class="py-lineno"> 64</tt> <a class="py-toggle" href="#" id="pack-toggle" onclick="return toggle('pack');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="sstruct-module.html#pack">pack</a><tt class="py-op">(</tt><tt class="py-param">format</tt><tt class="py-op">,</tt> <tt class="py-param">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="pack-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="pack-expanded"><a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line">        <tt class="py-name">formatstring</tt><tt class="py-op">,</tt> <tt class="py-name">names</tt><tt class="py-op">,</tt> <tt class="py-name">fixes</tt> <tt class="py-op">=</tt> <tt id="link-1" class="py-name" targets="Function sstruct.getformat()=sstruct-module.html#getformat"><a title="sstruct.getformat" class="py-name" href="#" onclick="return doclink('link-1', 'getformat', 'link-1');">getformat</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">)</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line">        <tt class="py-name">elements</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt id="link-2" class="py-name" targets="Variable ottd_client_event.IRCChat.type=ottd_client_event.IRCChat-class.html#type"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-2', 'type', 'link-2');">type</a></tt><tt class="py-op">(</tt><tt class="py-name">object</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">DictType</tt><tt class="py-op">:</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line">                <tt class="py-name">object</tt> <tt class="py-op">=</tt> <tt class="py-name">object</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt id="link-3" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-3', 'name', 'link-0');">name</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">names</tt><tt class="py-op">:</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line">                <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">object</tt><tt class="py-op">[</tt><tt id="link-4" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-4', 'name', 'link-0');">name</a></tt><tt class="py-op">]</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">fixes</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt id="link-5" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-5', 'name', 'link-0');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line">                        <tt class="py-comment"># fixed point conversion</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line">                        <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">round</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">*</tt><tt class="py-name">fixes</tt><tt class="py-op">[</tt><tt id="link-6" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-6', 'name', 'link-0');">name</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line">                <tt class="py-name">elements</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">value</tt><tt class="py-op">)</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line">        <tt id="link-7" class="py-name" targets="Variable openttd.client.DataPacket.data=openttd.client.DataPacket-class.html#data,Variable openttd.savegame.CDataPacket.data=openttd.savegame.CDataPacket-class.html#data"><a title="openttd.client.DataPacket.data
openttd.savegame.CDataPacket.data" class="py-name" href="#" onclick="return doclink('link-7', 'data', 'link-7');">data</a></tt> <tt class="py-op">=</tt> <tt class="py-name">apply</tt><tt class="py-op">(</tt><tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Function sstruct.pack()=sstruct-module.html#pack"><a title="sstruct.pack" class="py-name" href="#" onclick="return doclink('link-8', 'pack', 'link-8');">pack</a></tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">formatstring</tt><tt class="py-op">,</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-name">elements</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-9" class="py-name"><a title="openttd.client.DataPacket.data
openttd.savegame.CDataPacket.data" class="py-name" href="#" onclick="return doclink('link-9', 'data', 'link-7');">data</a></tt> </tt>
</div><a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"> </tt>
<a name="unpack"></a><div id="unpack-def"><a name="L78"></a><tt class="py-lineno"> 78</tt> <a class="py-toggle" href="#" id="unpack-toggle" onclick="return toggle('unpack');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="sstruct-module.html#unpack">unpack</a><tt class="py-op">(</tt><tt class="py-param">format</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">,</tt> <tt class="py-param">object</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="unpack-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="unpack-expanded"><a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt class="py-name">object</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line">                <tt class="py-name">object</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line">        <tt class="py-name">formatstring</tt><tt class="py-op">,</tt> <tt class="py-name">names</tt><tt class="py-op">,</tt> <tt class="py-name">fixes</tt> <tt class="py-op">=</tt> <tt id="link-10" class="py-name"><a title="sstruct.getformat" class="py-name" href="#" onclick="return doclink('link-10', 'getformat', 'link-1');">getformat</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">)</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line">        <tt class="py-keyword">if</tt> <tt id="link-11" class="py-name"><a title="ottd_client_event.IRCChat.type" class="py-name" href="#" onclick="return doclink('link-11', 'type', 'link-2');">type</a></tt><tt class="py-op">(</tt><tt class="py-name">object</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">DictType</tt><tt class="py-op">:</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line">                <tt class="py-name">dict</tt> <tt class="py-op">=</tt> <tt class="py-name">object</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line">        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line">                <tt class="py-name">dict</tt> <tt class="py-op">=</tt> <tt class="py-name">object</tt><tt class="py-op">.</tt><tt class="py-name">__dict__</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line">        <tt class="py-name">elements</tt> <tt class="py-op">=</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Function sstruct.unpack()=sstruct-module.html#unpack"><a title="sstruct.unpack" class="py-name" href="#" onclick="return doclink('link-12', 'unpack', 'link-12');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-name">formatstring</tt><tt class="py-op">,</tt> <tt id="link-13" class="py-name"><a title="openttd.client.DataPacket.data
openttd.savegame.CDataPacket.data" class="py-name" href="#" onclick="return doclink('link-13', 'data', 'link-7');">data</a></tt><tt class="py-op">)</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">range</tt><tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">names</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line">                <tt id="link-14" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-14', 'name', 'link-0');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">names</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line">                <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">elements</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line">                <tt class="py-keyword">if</tt> <tt class="py-name">fixes</tt><tt class="py-op">.</tt><tt class="py-name">has_key</tt><tt class="py-op">(</tt><tt id="link-15" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-15', 'name', 'link-0');">name</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line">                        <tt class="py-comment"># fixed point conversion</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line">                        <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> <tt class="py-op">/</tt> <tt class="py-name">fixes</tt><tt class="py-op">[</tt><tt id="link-16" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-16', 'name', 'link-0');">name</a></tt><tt class="py-op">]</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line">                <tt class="py-name">dict</tt><tt class="py-op">[</tt><tt id="link-17" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-17', 'name', 'link-0');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">object</tt> </tt>
</div><a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"> </tt>
<a name="unpack2"></a><div id="unpack2-def"><a name="L96"></a><tt class="py-lineno"> 96</tt> <a class="py-toggle" href="#" id="unpack2-toggle" onclick="return toggle('unpack2');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="sstruct-module.html#unpack2">unpack2</a><tt class="py-op">(</tt><tt class="py-param">format</tt><tt class="py-op">,</tt> <tt class="py-param">data</tt><tt class="py-op">,</tt> <tt class="py-param">object</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="unpack2-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="unpack2-expanded"><a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line">        <tt class="py-name">length</tt> <tt class="py-op">=</tt> <tt id="link-18" class="py-name" targets="Function sstruct.calcsize()=sstruct-module.html#calcsize"><a title="sstruct.calcsize" class="py-name" href="#" onclick="return doclink('link-18', 'calcsize', 'link-18');">calcsize</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">)</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt id="link-19" class="py-name"><a title="sstruct.unpack" class="py-name" href="#" onclick="return doclink('link-19', 'unpack', 'link-12');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">,</tt> <tt id="link-20" class="py-name"><a title="openttd.client.DataPacket.data
openttd.savegame.CDataPacket.data" class="py-name" href="#" onclick="return doclink('link-20', 'data', 'link-7');">data</a></tt><tt class="py-op">[</tt><tt class="py-op">:</tt><tt class="py-name">length</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">object</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt id="link-21" class="py-name"><a title="openttd.client.DataPacket.data
openttd.savegame.CDataPacket.data" class="py-name" href="#" onclick="return doclink('link-21', 'data', 'link-7');">data</a></tt><tt class="py-op">[</tt><tt class="py-name">length</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
</div><a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"> </tt>
<a name="calcsize"></a><div id="calcsize-def"><a name="L100"></a><tt class="py-lineno">100</tt> <a class="py-toggle" href="#" id="calcsize-toggle" onclick="return toggle('calcsize');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="sstruct-module.html#calcsize">calcsize</a><tt class="py-op">(</tt><tt class="py-param">format</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="calcsize-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="calcsize-expanded"><a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line">        <tt class="py-name">formatstring</tt><tt class="py-op">,</tt> <tt class="py-name">names</tt><tt class="py-op">,</tt> <tt class="py-name">fixes</tt> <tt class="py-op">=</tt> <tt id="link-22" class="py-name"><a title="sstruct.getformat" class="py-name" href="#" onclick="return doclink('link-22', 'getformat', 'link-1');">getformat</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">)</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">struct</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="sstruct.calcsize" class="py-name" href="#" onclick="return doclink('link-23', 'calcsize', 'link-18');">calcsize</a></tt><tt class="py-op">(</tt><tt class="py-name">formatstring</tt><tt class="py-op">)</tt> </tt>
</div><a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line"> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-comment"># matches "name:formatchar" (whitespace is allowed)</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line"><tt id="link-24" class="py-name" targets="Variable sstruct._elementRE=sstruct-module.html#_elementRE"><a title="sstruct._elementRE" class="py-name" href="#" onclick="return doclink('link-24', '_elementRE', 'link-24');">_elementRE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line">                <tt class="py-string">"\s*"</tt>                                                   <tt class="py-comment"># whitespace</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line">                <tt class="py-string">"([A-Za-z_][A-Za-z_0-9]*)"</tt>              <tt class="py-comment"># name (python identifier)</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line">                <tt class="py-string">"\s*:\s*"</tt>                                               <tt class="py-comment"># whitespace : whitespace</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line">                <tt class="py-string">"([cbBhHiIlLfd]|[0-9]+[ps]|"</tt>    <tt class="py-comment"># formatchar...</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line">                        <tt class="py-string">"([0-9]+)\.([0-9]+)(F))"</tt>        <tt class="py-comment"># ...formatchar</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line">                <tt class="py-string">"\s*"</tt>                                                   <tt class="py-comment"># whitespace</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line">                <tt class="py-string">"(#.*)?$"</tt>                                               <tt class="py-comment"># [comment] + end of string</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line">        <tt class="py-op">)</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line"><tt class="py-comment"># matches the special struct format chars and 'x' (pad byte)</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt id="link-25" class="py-name" targets="Variable sstruct._extraRE=sstruct-module.html#_extraRE"><a title="sstruct._extraRE" class="py-name" href="#" onclick="return doclink('link-25', '_extraRE', 'link-25');">_extraRE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">"\s*([x@=&lt;&gt;!])\s*(#.*)?$"</tt><tt class="py-op">)</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-comment"># matches an "empty" string, possibly containing whitespace and/or a comment</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt id="link-26" class="py-name" targets="Variable sstruct._emptyRE=sstruct-module.html#_emptyRE"><a title="sstruct._emptyRE" class="py-name" href="#" onclick="return doclink('link-26', '_emptyRE', 'link-26');">_emptyRE</a></tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">compile</tt><tt class="py-op">(</tt><tt class="py-string">"\s*(#.*)?$"</tt><tt class="py-op">)</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line"> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"><tt id="link-27" class="py-name" targets="Variable sstruct._fixedpointmappings=sstruct-module.html#_fixedpointmappings"><a title="sstruct._fixedpointmappings" class="py-name" href="#" onclick="return doclink('link-27', '_fixedpointmappings', 'link-27');">_fixedpointmappings</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line">                <tt class="py-number">8</tt><tt class="py-op">:</tt> <tt class="py-string">"b"</tt><tt class="py-op">,</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line">                <tt class="py-number">16</tt><tt class="py-op">:</tt> <tt class="py-string">"h"</tt><tt class="py-op">,</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line">                <tt class="py-number">32</tt><tt class="py-op">:</tt> <tt class="py-string">"l"</tt><tt class="py-op">}</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line"><tt id="link-28" class="py-name" targets="Variable sstruct._formatcache=sstruct-module.html#_formatcache"><a title="sstruct._formatcache" class="py-name" href="#" onclick="return doclink('link-28', '_formatcache', 'link-28');">_formatcache</a></tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"> </tt>
<a name="getformat"></a><div id="getformat-def"><a name="L129"></a><tt class="py-lineno">129</tt> <a class="py-toggle" href="#" id="getformat-toggle" onclick="return toggle('getformat');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="sstruct-module.html#getformat">getformat</a><tt class="py-op">(</tt><tt class="py-param">format</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="getformat-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="getformat-expanded"><a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line">                <tt class="py-name">formatstring</tt><tt class="py-op">,</tt> <tt class="py-name">names</tt><tt class="py-op">,</tt> <tt class="py-name">fixes</tt> <tt class="py-op">=</tt> <tt id="link-29" class="py-name"><a title="sstruct._formatcache" class="py-name" href="#" onclick="return doclink('link-29', '_formatcache', 'link-28');">_formatcache</a></tt><tt class="py-op">[</tt><tt class="py-name">format</tt><tt class="py-op">]</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">KeyError</tt><tt class="py-op">:</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line">                <tt class="py-name">lines</tt> <tt class="py-op">=</tt> <tt class="py-name">re</tt><tt class="py-op">.</tt><tt class="py-name">split</tt><tt class="py-op">(</tt><tt class="py-string">"[\n;]"</tt><tt class="py-op">,</tt> <tt class="py-name">format</tt><tt class="py-op">)</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line">                <tt class="py-name">formatstring</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line">                <tt class="py-name">names</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line">                <tt class="py-name">fixes</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line">                <tt class="py-keyword">for</tt> <tt class="py-name">line</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lines</tt><tt class="py-op">:</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line">                        <tt class="py-keyword">if</tt> <tt id="link-30" class="py-name"><a title="sstruct._emptyRE" class="py-name" href="#" onclick="return doclink('link-30', '_emptyRE', 'link-26');">_emptyRE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line">                                <tt class="py-keyword">continue</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line">                        <tt class="py-name">m</tt> <tt class="py-op">=</tt> <tt id="link-31" class="py-name"><a title="sstruct._extraRE" class="py-name" href="#" onclick="return doclink('link-31', '_extraRE', 'link-25');">_extraRE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line">                        <tt class="py-keyword">if</tt> <tt class="py-name">m</tt><tt class="py-op">:</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line">                                <tt class="py-name">formatchar</tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line">                                <tt class="py-keyword">if</tt> <tt class="py-name">formatchar</tt> <tt class="py-op">&lt;&gt;</tt> <tt class="py-string">'x'</tt> <tt class="py-keyword">and</tt> <tt class="py-name">formatstring</tt><tt class="py-op">:</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line">                                        <tt class="py-keyword">raise</tt> <tt id="link-32" class="py-name" targets="Class sstruct.error=sstruct.error-class.html"><a title="sstruct.error" class="py-name" href="#" onclick="return doclink('link-32', 'error', 'link-32');">error</a></tt><tt class="py-op">,</tt> <tt class="py-string">"a special format char must be first"</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line">                        <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line">                                <tt class="py-name">m</tt> <tt class="py-op">=</tt> <tt id="link-33" class="py-name"><a title="sstruct._elementRE" class="py-name" href="#" onclick="return doclink('link-33', '_elementRE', 'link-24');">_elementRE</a></tt><tt class="py-op">.</tt><tt class="py-name">match</tt><tt class="py-op">(</tt><tt class="py-name">line</tt><tt class="py-op">)</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line">                                <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">m</tt><tt class="py-op">:</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line">                                        <tt class="py-keyword">raise</tt> <tt id="link-34" class="py-name"><a title="sstruct.error" class="py-name" href="#" onclick="return doclink('link-34', 'error', 'link-32');">error</a></tt><tt class="py-op">,</tt> <tt class="py-string">"syntax error in format: '%s'"</tt> <tt class="py-op">%</tt> <tt class="py-name">line</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line">                                <tt id="link-35" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-35', 'name', 'link-0');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line">                                <tt class="py-name">names</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-36" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-36', 'name', 'link-0');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line">                                <tt class="py-name">formatchar</tt> <tt class="py-op">=</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">2</tt><tt class="py-op">)</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line">                                <tt class="py-keyword">if</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">3</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line">                                        <tt class="py-comment"># fixed point</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line">                                        <tt class="py-name">before</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">3</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line">                                        <tt class="py-name">after</tt> <tt class="py-op">=</tt> <tt class="py-name">int</tt><tt class="py-op">(</tt><tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">4</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line">                                        <tt class="py-name">bits</tt> <tt class="py-op">=</tt> <tt class="py-name">before</tt> <tt class="py-op">+</tt> <tt class="py-name">after</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line">                                        <tt class="py-keyword">if</tt> <tt class="py-name">bits</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">[</tt><tt class="py-number">8</tt><tt class="py-op">,</tt> <tt class="py-number">16</tt><tt class="py-op">,</tt> <tt class="py-number">32</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line">                                                <tt class="py-keyword">raise</tt> <tt id="link-37" class="py-name"><a title="sstruct.error" class="py-name" href="#" onclick="return doclink('link-37', 'error', 'link-32');">error</a></tt><tt class="py-op">,</tt> <tt class="py-string">"fixed point must be 8, 16 or 32 bits long"</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line">                                        <tt class="py-name">formatchar</tt> <tt class="py-op">=</tt> <tt id="link-38" class="py-name"><a title="sstruct._fixedpointmappings" class="py-name" href="#" onclick="return doclink('link-38', '_fixedpointmappings', 'link-27');">_fixedpointmappings</a></tt><tt class="py-op">[</tt><tt class="py-name">bits</tt><tt class="py-op">]</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line">                                        <tt class="py-keyword">assert</tt> <tt class="py-name">m</tt><tt class="py-op">.</tt><tt class="py-name">group</tt><tt class="py-op">(</tt><tt class="py-number">5</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-string">"F"</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line">                                        <tt class="py-name">fixes</tt><tt class="py-op">[</tt><tt id="link-39" class="py-name"><a title="sstruct.error.name" class="py-name" href="#" onclick="return doclink('link-39', 'name', 'link-0');">name</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">float</tt><tt class="py-op">(</tt><tt class="py-number">1</tt> <tt class="py-op">&lt;&lt;</tt> <tt class="py-name">after</tt><tt class="py-op">)</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line">                        <tt class="py-name">formatstring</tt> <tt class="py-op">=</tt> <tt class="py-name">formatstring</tt> <tt class="py-op">+</tt> <tt class="py-name">formatchar</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line">                <tt id="link-40" class="py-name"><a title="sstruct._formatcache" class="py-name" href="#" onclick="return doclink('link-40', '_formatcache', 'link-28');">_formatcache</a></tt><tt class="py-op">[</tt><tt class="py-name">format</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">formatstring</tt><tt class="py-op">,</tt> <tt class="py-name">names</tt><tt class="py-op">,</tt> <tt class="py-name">fixes</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">formatstring</tt><tt class="py-op">,</tt> <tt class="py-name">names</tt><tt class="py-op">,</tt> <tt class="py-name">fixes</tt> </tt>
</div><a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line"> </tt>
<a name="_test"></a><div id="_test-def"><a name="L166"></a><tt class="py-lineno">166</tt> <a class="py-toggle" href="#" id="_test-toggle" onclick="return toggle('_test');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="sstruct-module.html#_test">_test</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_test-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_test-expanded"><a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line">        <tt class="py-name">format</tt> <tt class="py-op">=</tt> <tt class="py-string">"""</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line"><tt class="py-string">                # comments are allowed</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line"><tt class="py-string">                &gt;  # big endian (see documentation for struct)</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt>  <tt class="py-line"><tt class="py-string">                # empty lines are allowed:</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line"><tt class="py-string">                </tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line"><tt class="py-string">                ashort: h</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line"><tt class="py-string">                along: l</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line"><tt class="py-string">                abyte: b        # a byte</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line"><tt class="py-string">                achar: c</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line"><tt class="py-string">                astr: 5s</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line"><tt class="py-string">                afloat: f; adouble: d   # multiple "statements" are allowed</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line"><tt class="py-string">                afixed: 16.16F</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line"><tt class="py-string">        """</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line">         </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">'size:'</tt><tt class="py-op">,</tt> <tt id="link-41" class="py-name"><a title="sstruct.calcsize" class="py-name" href="#" onclick="return doclink('link-41', 'calcsize', 'link-18');">calcsize</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">)</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line">         </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line">        <tt class="py-keyword">class</tt> <tt class="py-def-name">foo</tt><tt class="py-op">:</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line">                <tt class="py-keyword">pass</tt> </tt>
</div><a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line">         </tt>
<a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line">        <tt class="py-name">i</tt> <tt class="py-op">=</tt> <tt class="py-name">foo</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line">         </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line">        <tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">ashort</tt> <tt class="py-op">=</tt> <tt class="py-number">0x7fff</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line">        <tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">along</tt> <tt class="py-op">=</tt> <tt class="py-number">0x7fffffff</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line">        <tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">abyte</tt> <tt class="py-op">=</tt> <tt class="py-number">0x7f</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line">        <tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">achar</tt> <tt class="py-op">=</tt> <tt class="py-string">"a"</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line">        <tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">astr</tt> <tt class="py-op">=</tt> <tt class="py-string">"12345"</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line">        <tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">afloat</tt> <tt class="py-op">=</tt> <tt class="py-number">0.5</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line">        <tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">adouble</tt> <tt class="py-op">=</tt> <tt class="py-number">0.5</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line">        <tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">afixed</tt> <tt class="py-op">=</tt> <tt class="py-number">1.5</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line">         </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line">        <tt id="link-42" class="py-name"><a title="openttd.client.DataPacket.data
openttd.savegame.CDataPacket.data" class="py-name" href="#" onclick="return doclink('link-42', 'data', 'link-7');">data</a></tt> <tt class="py-op">=</tt> <tt id="link-43" class="py-name"><a title="sstruct.pack" class="py-name" href="#" onclick="return doclink('link-43', 'pack', 'link-8');">pack</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">,</tt> <tt class="py-name">i</tt><tt class="py-op">)</tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">'data:'</tt><tt class="py-op">,</tt> <tt class="py-op">`</tt><tt id="link-44" class="py-name"><a title="openttd.client.DataPacket.data
openttd.savegame.CDataPacket.data" class="py-name" href="#" onclick="return doclink('link-44', 'data', 'link-7');">data</a></tt><tt class="py-op">`</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt id="link-45" class="py-name"><a title="sstruct.unpack" class="py-name" href="#" onclick="return doclink('link-45', 'unpack', 'link-12');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">,</tt> <tt id="link-46" class="py-name"><a title="openttd.client.DataPacket.data
openttd.savegame.CDataPacket.data" class="py-name" href="#" onclick="return doclink('link-46', 'data', 'link-7');">data</a></tt><tt class="py-op">)</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line">        <tt class="py-name">i2</tt> <tt class="py-op">=</tt> <tt class="py-name">foo</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line">        <tt id="link-47" class="py-name"><a title="sstruct.unpack" class="py-name" href="#" onclick="return doclink('link-47', 'unpack', 'link-12');">unpack</a></tt><tt class="py-op">(</tt><tt class="py-name">format</tt><tt class="py-op">,</tt> <tt id="link-48" class="py-name"><a title="openttd.client.DataPacket.data
openttd.savegame.CDataPacket.data" class="py-name" href="#" onclick="return doclink('link-48', 'data', 'link-7');">data</a></tt><tt class="py-op">,</tt> <tt class="py-name">i2</tt><tt class="py-op">)</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-name">vars</tt><tt class="py-op">(</tt><tt class="py-name">i2</tt><tt class="py-op">)</tt> </tt>
</div><a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line"> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line"><tt class="py-keyword">if</tt> <tt class="py-name">__name__</tt> <tt class="py-op">==</tt> <tt class="py-string">"__main__"</tt><tt class="py-op">:</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line">        <tt id="link-49" class="py-name" targets="Function sstruct._test()=sstruct-module.html#_test"><a title="sstruct._test" class="py-name" href="#" onclick="return doclink('link-49', '_test', 'link-49');">_test</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://openttd-python.googlecode.com">OpenTTD-Python</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Oct 20 13:03:13 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
